SDF 문서 구조 정리 기획안
개요
본 문서는 SDF 제품 문서를 중앙화 및 체계화하기 위한 기획안입니다.
현재 산출물들이 개인 PC, 부서별 폴더, 프로젝트 단위 저장소 등으로 분산되어 관리되고 있으며, 이로 인해 다음과 같은 문제가 발생하고 있습니다.
- 문서의 위치 파악이 어렵고 검색성이 떨어짐
- 담당자 변경 시 인수인계 지연 및 누락 발생
- 동일/유사 문서의 중복 작성으로 인한 비효율
이에 따라, 본 기획안은 외부 제공용 문서(영업–준비–구축–검수) 와 내부 관리용 문서(기획–개발–QA–운영) 를 모두 포함하는 이중 구조 문서 체계를 수립하여, 전사적으로 일관성 있고 재사용 가능한 문서 관리 체계를 마련하는 것을 목표로 합니다.
문제 인식
- 분산 관리로 인해 문서 품질, 접근성, 재활용성 저하
개선 필요성
- 중앙화 : 모든 산출물을 단일 저장소에서 관리
- 체계화 : 단계별 산출물 구조를 정의하고 템플릿 기반 관리
- 재사용성 모든 제품 docs 동일한 구조 적용
- 품질 관리 : 버전 관리, 검수 기록, 담당자 메타데이터 포함
제안 구조 (이중 구조)
1. 외부 제공 문서
- 영업 단계 : 제품 소개자료, 브로슈어, 기능 리스트, FAQ
- 준비 단계 : 환경분석 질의서, 제품 구성도, H/W 스펙
- 구축 단계 : 설치 가이드, API 명세서, 테스트 소스, 트러블슈팅
- 검수 단계 : 체크리스트
2. 내부 관리 문서
- 기획 (Planning) : 로드맵, 요구사항 정의서, 기능 명세서, 릴리즈 계획
- 개발 (Development) : 아키텍처 설계, DB 스키마, 내부 API 명세, 개발 로그
- 품질 관리 (QA) : 테스트 케이스, 버그 리포트, 회귀 테스트 체크리스트
- 운영 (Ops) : 모 니터링 가이드, 장애 보고서, SLA 문서
- 내부 FAQ(Internal FAQ): 제품 별 내부 FAQ
- FAQ는 외부 고객용(제품별 external/01.Sales/FAQ)과 내부 운영용(제품별 internal/50.Internal_FAQ)으로 관리
3. 통합 폴더 트리
docs-sdf/
├─ sdf_common/ # 공통 자료
│ ├─ Product_Info/ # 제품 정보
│ │ ├─ Product_Intro/ # 제품 소개
│ │ └─ Brochure/ # 브로슈어
│ └─ Preparation/ # 준비 자료
│ └─ System_Architecture/ # 시스템 아키텍처
├─ sdf_app/ # SDF App
│ ├─ 01.Product_Info/ # 외부 제공 문서
│ │ ├─ Product_Spec/ # 제품 사양서(요구 HW/SW, 지원환경)
│ │ ├─ Feature_List/ # 기능 리스트
│ │ └─ FAQ/ # 고객용 FAQ
│ │ └─ Glossary/ # 용어집
│ │ └─ glossary.md
│ │ └─ Guide/ # 공개용 가이드
│ │ ├─ User_Guide/
│ │ └─ Admin_Guide/
│ ├─ 02.Preparation/
│ │ └─ Env_Query/ # 환경 질의서(사전 요구사항 확인서)
│ ├─ 03.Deployment/
│ │ ├─ Install_Guide/ # 설치 가이드
│ │ ├─ API_Spec/
│ │ ├─ Architecture_Diagram/
│ │ └─ Troubleshooting/
│ ├─ 04.Validation/
│ └─ internal/ # 내부 관리 문서
│ ├─ 10.Planning/ # 로드맵, 유스케이스, 릴리즈 계획
│ ├─ 20.Development/ # 설계, DB 스키마, 내부 API, 개발 로그
│ │ └─ Detailed_Spec/ # 상세 사양서(내부 세부 스펙)
│ ├─ 30.Deployment_Guide/ # 내부 구축/설치 가이드
│ ├─ 40.QA/ # 테스트 계획, 케이스, 버그 리포트
│ │ ├─ Test_Plan/
│ │ ├─ Test_Case/
│ │ └─ Test_Report/
│ ├─ 50.Ops/ # 모니터링, 장애 보고, 운영 가이드
│ └─ 60.Internal_FAQ/ # 내부 FAQ
│ └─ Internal_FAQ_App.md
│
├─ sdf_container/ # SDF Container
│ ├─ 01.Product_Info/
│ │ ├─ Product_Spec/
│ │ ├─ Env_Query/
│ │ ├─ Feature_List/
│ │ └─ FAQ/
│ │ └─ Glossary/
│ │ └─ glossary.md
│ │ └─ Guide/
│ │ ├─ User_Guide/
│ │ └─ Admin_Guide/
│ ├─ 02.Preparation/
│ │ └─ Env_Query/
│ ├─ 03.Deployment/
│ │ ├─ Install_Guide/
│ │ ├─ API_Spec/
│ │ ├─ Architecture_Diagram/
│ │ └─ Troubleshooting/
│ └─ internal/
│ ├─ 10.Planning/
│ ├─ 20.Development/
│ │ └─ Detailed_Spec/
│ ├─ 30.Deployment_Guide/
│ ├─ 40.QA/
│ │ ├─ Test_Plan/
│ │ ├─ Test_Case/
│ │ └─ Test_Report/
│ ├─ 50.Ops/
│ └─ 60.Internal_FAQ/
│ └─ Internal_FAQ_App.md
│
├─ sdf_windows/ # SDF Windows (예정)
│ ├─ 01.Product_Info/
│ │ ├─ Product_Spec/
│ │ ├─ Env_Query/
│ │ ├─ Feature_List/
│ │ └─ FAQ/
│ │ └─ Glossary/
│ │ └─ glossary.md
│ │ └─ Guide/
│ │ ├─ User_Guide/
│ │ └─ Admin_Guide/
│ ├─ 02.Preparation/
│ ├─ 03.Deployment/
│ │ ├─ Install_Guide/
│ │ ├─ API_Spec/
│ │ ├─ Architecture_Diagram/
│ │ └─ Troubleshooting/
│ ├─ 04.Validation/
│ └─ internal/
│ ├─ 10.Planning/
│ ├─ 20.Development/
│ │ └─ Detailed_Spec/
│ ├─ 30.Deployment_Guide/
│ ├─ 40.QA/
│ │ ├─ Test_Plan/
│ │ ├─ Test_Case/
│ │ └─ Test_Report/
│ ├─ 50.Ops/
│ └─ 60.Internal_FAQ/
│ └─ Internal_FAQ_App.md
├─ _assets/ # 내 부 전용(비공개): 이미지/다이어그램/스크린샷
├─ _templates/ # 내부 전용(비공개): 공통 문서 템플릿
└─ README.md
추진 계획
- 1단계 (초안 설계) : 제품별/내외부 구분 구조로 초안 설계
- 2단계 (문서 이관) : 기존 문서를 신규 구조에 맞춰 이동 및 정리
- 3단계 (부서 검토) : 기획/개발/영업/운영 각 부서별 검토
- 4단계 (적용/확산) : SDF 우선 적용 후 타제품(DRM, Mail) 동일 체계로 확산
- 5단계: 운영 규칙 확립 – 내부 자원(
_assets,_templates) 비공개 관리 규칙 확정
기대 효과
- 일관성: 모든 제품이 동일한 문서 구조 체계를 따름
- 문서 중앙화 : 흩어진 산출물을 단일 저장소로 집약 → 접근성·검색성 개선
- 구성별 최적화: App, Container, Windows 각각의 특성이 반영된 문서 관리
- 내·외부 분리: 고객용 문서와 내부 관리 문서가 명확히 구분되어 혼선 최소화
- 보안 강화: 내부 전용 자료(
_assets,_templates)는 외부에 공개되지 않음 - 확장성: 새로운 구성/제품이 추가될 때 동일 체계 적용 가능